Package com.cisco.pt.ipc.sim.impl
Class EnvironmentKeyframeImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.EnvironmentKeyframeImpl
- All Implemented Interfaces:
IPCObject,EnvironmentKeyframe
Information provided by the PKI file:
\class EnvironmentKeyframe
\brief An object in the Physical Workspace.
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionEnvironmentKeyframeImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptiongetEnvironment(String env) Information provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:intgetTime()Information provided by the PKI file:voidsetTime(int time) Information provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Constructor Details
-
EnvironmentKeyframeImpl
public EnvironmentKeyframeImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
getTime
public int getTime()Information provided by the PKI file:
\brief Returns the time the keyframe is set to exist at, in seconds. \return int, value is the time the keyframe resides at, in seconds.- Specified by:
getTimein interfaceEnvironmentKeyframe- Returns:
- int Returns a int
-
setTime
public void setTime(int time) Information provided by the PKI file:
\brief Sets the time the keyframe exists at, in seconds. \param time, value is the time the keyframe resides at, in seconds.- Specified by:
setTimein interfaceEnvironmentKeyframe- Parameters:
time- Takes in a parameter of time
-
getEnvironmentOptionsCount
public int getEnvironmentOptionsCount()Information provided by the PKI file:
\brief Returns how many different environment value properties ("CO", "Sunlight", etc) are in the key frame. \return int, value is how many different environment value properties ("CO", "Sunlight", etc) are in the key frame.- Specified by:
getEnvironmentOptionsCountin interfaceEnvironmentKeyframe- Returns:
- int Returns a int
-
getEnvironmentKeys
Information provided by the PKI file:
\brief Returns the names of all the environment value properties ("CO", "Sunlight", etc) are in the key frame. \return vector<QString>, a list with an entry for each environment property name in the keyframe.- Specified by:
getEnvironmentKeysin interfaceEnvironmentKeyframe- Returns:
- List<String> Returns a List<String>
-
getEnvironment
Information provided by the PKI file:
\brief Returns the environment properties for the environment value property type passed. \param env, Name of the environment property type to get the properties for. Like "CO", "Sunlight", etc. \return EnvironmentOptions, the enivronment options for the given environment value type.- Specified by:
getEnvironmentin interfaceEnvironmentKeyframe- Parameters:
env- Takes in a parameter of env- Returns:
- EnvironmentOptions Returns a EnvironmentOptions
-